Deprecate bundled MockServer module in favour of the MockServer-maintained module#11833
Deprecate bundled MockServer module in favour of the MockServer-maintained module#11833jamesdbloom wants to merge 3 commits into
Conversation
…ained module The bundled module has no configuration helpers and defaults to a retired image. MockServer now publishes and maintains its own Testcontainers module, org.mock-server:mockserver-testcontainers (org.mockserver.testcontainers.MockServerContainer), which derives the image tag from the client library so container and client stay in version lockstep and adds DNS, transparent-proxy, HTTP/3, initialization-JSON, log-level and arbitrary-property helpers plus direct MockServerClient wiring. This deprecates the bundled classes with a Javadoc pointer to the maintained module, and adds a note to the module docs recommending it for new projects. Signed-off-by: James D Bloom <733179+jamesdbloom@users.noreply.github.com>
…erver-7.0.0 The default image was the retired jamesdbloom/mockserver:mockserver-5.5.4. Point it at the current mockserver/mockserver:mockserver-7.0.0. assertCompatibleWith already accepts both jamesdbloom/mockserver and mockserver/mockserver, so existing callers are unaffected. Signed-off-by: James D Bloom <733179+jamesdbloom@users.noreply.github.com>
kiview
left a comment
kiview
left a comment
There was a problem hiding this comment.
Thanks for working on this deprecation — the !!! note callout in the docs, the Javadoc migration description, and the overall intent are clear and well-written, and CI is fully green. There are a couple of things to resolve before this can merge, plus a few smaller nits.
Blocking — must fix before merge
1. Image/tag bump is untested and inconsistent
The PR changes DEFAULT_TAG from mockserver-5.5.4 → mockserver-7.0.0 and DEFAULT_IMAGE_NAME from jamesdbloom/mockserver → mockserver/mockserver, but build.gradle still pins mockserver-client-java:5.15.0 (which corresponds to image mockserver-5.15.0, not 7.0.0). These two are now out of sync. The log-wait strategy (".*started on port: 1080.*") is also unverified against MockServer 7.x logs.
Please either:
- (a) Align the
mockserver-client-javadependency to7.0.0, verify the wait strategy still matches, and confirm the integration tests pass against MockServer 7.x; or - (b) Drop the image/tag bump entirely from this PR and keep it focused purely on the deprecation — the image bump can follow in a separate PR once it's been validated end-to-end.
2. Frozen implementation left without a comment
MockServerContainer (in org.testcontainers.mockserver) now carries @Deprecated but its implementation is otherwise unchanged — it still references the old image/tag defaults (or the new unverified ones, depending on resolution above). Either way, a short inline comment explaining this is intentional would prevent future confusion:
// Intentionally frozen at this image/tag; see deprecation notice above.
private static final DockerImageName DEFAULT_IMAGE_NAME = ...Non-blocking — please fix if possible
3. Test class instantiates @Deprecated class without @SuppressWarnings("deprecation")
MockServerContainerTest constructs the now-deprecated MockServerContainer directly. Project convention (see ElasticsearchContainerTest, CassandraContainerTest) is to annotate the test class or method with @SuppressWarnings("deprecation") and a brief comment:
@SuppressWarnings("deprecation") // testing the deprecated bundled module
class MockServerContainerTest { ... }4. Javadoc URLs are plain text
Both new Javadoc blocks end with a bare URL string. Please use a proper @see tag so it renders as a hyperlink in IDEs and generated Javadoc HTML:
* @see <a href="https://www.mock-server.com/mock_server/mockserver_testcontainers.html">MockServer Testcontainers module</a>5. Pre-existing broken codeinclude in mockserver.md
The testSimpleExpectation codeinclude reference in mockserver.md was already broken before this PR. Since you're editing that file anyway, it would be a good opportunity to fix or remove it — happy to leave it for a follow-up if you'd prefer to keep this PR focused.
Once items 1 and 2 are resolved this will be in great shape. Happy to clarify anything!
Make the bundled module's image/tag consistent with the verified client version and resolve the review items raised on the deprecation PR. - Bump the test mockserver-client-java dependency 5.15.0 -> 7.1.0 so it is the single source of truth for the MockServer version; the test already derives its container image tag from this client jar, so container and client now stay in lockstep, and the active MockServerContainer default tag is aligned to mockserver-7.1.0 to match. Verified: the test sources compile against the 7.1.0 client, and the mockserver/mockserver:mockserver-7.1.0 image starts emitting "started on port: 1080" (so the existing wait strategy still matches) and serves a simple expectation. - Explain the frozen defaults: the superseded org.testcontainers.containers redirect stub intentionally keeps its legacy jamesdbloom/mockserver default for backwards compatibility, and the active default tag carries a note that it tracks the client version in build.gradle. - Annotate MockServerContainerTest with @SuppressWarnings("deprecation"), matching the convention used by other deprecated-module tests. - Turn the bare Javadoc URLs into @see anchor tags so they render as links. - Fix the broken testSimpleExpectation codeinclude by adding the missing block markers in MockServerContainerTest, so the snippet in docs/modules/mockserver.md resolves. Signed-off-by: James D Bloom <733179+jamesdbloom@users.noreply.github.com>
|
Thanks for the thorough review, @kiview! I've pushed a follow-up commit addressing all five points. 1. Image/tag bump untested & inconsistent (blocking) — Resolved by aligning the version end-to-end rather than dropping it. The test already derives its image tag from
2. Frozen implementation without a comment (blocking) — Added comments explaining the defaults: the superseded 3. 4. Plain-text Javadoc URLs — Both now use 5. Broken Happy to adjust anything further. |
2 participants
The bundled
org.testcontainers.mockserver.MockServerContainerships a single TCP port,defaults to the retired
jamesdbloom/mockserver:mockserver-5.5.4image, and has noconfiguration helpers.
MockServer now publishes and maintains its own Testcontainers module,
org.mock-server:mockserver-testcontainers(org.mockserver.testcontainers.MockServerContainer),which derives the image tag from the client library so container and client stay in version
lockstep, exposes DNS, transparent-proxy (NET_ADMIN), HTTP/3, initialization-JSON, log-level and
arbitrary-property helpers, and provides direct
MockServerClientwiring viagetClient().This PR deprecates the bundled class with a Javadoc pointer to the MockServer-maintained module so
existing users are guided to the supported option, and (separate commit) refreshes the stale default
image. Maintained by the MockServer project (github.com/mock-server).